home *** CD-ROM | disk | FTP | other *** search
/ PC Active 2009 July/August / PC Active NR.227.iso / Software / Games / windows / Freeciv-2.1.9-win32-gtk2-setup.exe / doc / README.rulesets < prev    next >
Encoding:
Text File  |  2009-03-25  |  4.9 KB  |  135 lines
  1. ----------------------------------------------------------------------
  2.                        Freeciv Rulesets
  3. ----------------------------------------------------------------------
  4.           (Originally by David Pfitzner, dwp@mso.anu.edu.au)
  5.  
  6. Quickstart:
  7. -----------
  8.  Rulesets allow modifiable sets of data for units, advances, terrain,
  9.  improvements, wonders, nations, cities, governments and miscellaneous
  10.  game rules, without requiring recompilation, in a way which is
  11.  consistent across a network and through savegames.
  12.  
  13. - To play Freeciv normally: don't do anything special; the new
  14.   features all have defaults which give the standard Freeciv 
  15.   behaviour.
  16.  
  17. - To play a game with rules more like Civ1, start the server with:
  18.        ./ser -r data/civ1.serv
  19.   (and any other command-line arguments you normally use; depending on
  20.   how you have Freeciv installed you may have to give the installed
  21.   data directory path instead of "data").  
  22.  
  23.   Start the client normally.  The client must be network-compatible
  24.   (usually meaning the same or similar version) but otherwise nothing
  25.   special is needed.  (However some third-party rulesets may
  26.   potentially require special graphics to work properly, in which case
  27.   the client should have those graphics available and be started with
  28.   an appropriate '--tiles' argument.)
  29.  
  30.   As well as a Civ1 style as above, Freeciv now has a Civ2 style
  31.   similary, although currently it is almost identical to standard
  32.   Freeciv rules.
  33.  
  34.   Note that the Freeciv AI might not play as well with rules other
  35.   than standard Freeciv.  The AI is supposed to understand and 
  36.   utilize all sane rules variations, so please report any AI 
  37.   failures so that they can be fixed.
  38.  
  39. The rest of this file contains:
  40.  
  41. - More detailed information on creating and using custom/mixed 
  42.   rulesets.
  43.  
  44. - Information on implementation, and notes for further development.
  45.  
  46. ----------------------------------------------------------------------
  47. Using and modifying rulesets:
  48. -----------------------------
  49.  
  50. Rulesets are specified using the server command "rulesetdir".  The 
  51. command above of "./ser -r data/civ1.serv" just reads a file which 
  52. uses this command (as well as a few of the standard server options).  
  53. The server command specifies in which directory the ruleset files
  54. are to be found.
  55.  
  56. The ruleset files in the data directory are user-editable, so you can
  57. modify them to create modified or custom rulesets (without having to
  58. recompile Freeciv).  It is suggested that you _don't_ edit the 
  59. existing files in the "default", "classic", "civ1" and "civ2"
  60. directories, but rather copy them to another directory and edit the
  61. copies.  This is so that its clear when you are using modified rules
  62. and not the standard ones.
  63.  
  64. The format used in the ruleset files should be fairly 
  65. self-explanatory.  A few points:
  66.  
  67. - The files are not all independent, since eg, units depend on
  68.   advances specified in the techs file.
  69.  
  70. - Units have a field, "roles", which is like "flags", but 
  71.   determines which units are used in various circumstances of the
  72.   game (rather than intrinsic properties of the unit).
  73.   See comments in common/unit.h
  74.  
  75. Properties of units and advances are now fairly well generalised.
  76. Properties of buildings are still rather inflexible.
  77.  
  78. (See utility/fciconv.[ch])
  79. The data charset is used in all data files and network transactions.
  80. This is UTF-8.  Currently, the rulesets are in latin1 (ISO-8859-1).
  81.  
  82. ----------------------------------------------------------------------
  83. Restrictions and Limitations:
  84. -----------------------------
  85.  
  86. units.ruleset:
  87.  
  88.   Restrictions:
  89.  
  90.     - At least one unit with role "FirstBuild" must be available
  91.       from the start (i.e., tech_req = "None").
  92.  
  93.     - There must be units for these roles:
  94.       - "Explorer"
  95.       - "FerryBoat"
  96.       - "Hut"
  97.       - "Barbarian"
  98.       - "BarbarianLeader"
  99.       - "BarbarianBuild"
  100.       - "BarbarianBoat"  (move_type must be "Sea")
  101.       - "BarbarianSea"
  102.  
  103.     - There must be at least one unit with flag "Cities".
  104.  
  105.   Limitations:
  106.  
  107.     - These unit flag combinations won't work:
  108.       - "Diplomat" and "Caravan"
  109.  
  110.     - These flags and roles work only for move_type "Land" units:
  111.       - "Diplomat"
  112.       - "Partisan"
  113.       - "Settler"
  114.       - "IgTer"
  115.       - "Marines"
  116.       - "Airbase"
  117.       - "Barbarian"
  118.       - "BarbarianTech"
  119.  
  120. ----------------------------------------------------------------------
  121. Implementation details:
  122. -----------------------
  123.  
  124. This section and following section will be mainly of interested to
  125. developers who are familiar with the Freeciv source code.
  126.  
  127. Rulesets are mainly implemented in the server.  The server reads the
  128. files, and then sends information to the clients.  Mostly rulesets 
  129. are used to fill in the basic data tables on units etc, but in some
  130. cases some extra information is required.
  131.  
  132. For units and advances, all information regarding each unit or advance
  133. is now captured in the data tables, and these are now "fully
  134. customizable", with the old enumeration types completely removed.
  135.